Access APIs

Access APIs for managing users, roles, tenants and other related system security operations

API Methods

★ Includes Example(s)
Can be used by Non-admin accounts

addDomainSettings

Add new AD LDAP server

2018.5

addProfile

Adds a User Profile

2020.0

addUserToRole

Add a user to a Role

2018.5

addUsersToRole

Add Users to a Role

2018.5

changeLicenseForUser

Change a User’s License Type

2018.5

changeRoleAdGroupMembership

Modify Active Directory Groups in a Role

2018.5

createRole

Create a Security Role

2018.5

createRoles

Create Security Roles

2018.5

createTenant

Create a Tenant

2018.5

createTenants

Create Multiple Tenants

2018.5

createUserAd

Create a new user (ACTIVE DIRECTORY)

2020.10

createUserDb

Create a new user (DATABASE)

2020.10

createUserOpenId

Create a new user (OpenID)

2020.20

createUserSaml

Create a new user (SAML)

2020.10

createUsersAd

Create multiple users (ACTIVE DIRECTORY)

2020.10

createUsersDb

Create multiple users (Internal / Database)

2020.10

createUsersOpenId

Create multiple users (OpenID)

2020.20

createUsersSaml

Create multiple users (SAML)

2020.10

deleteProfile

Removes a user profile from the system

2020.0

deleteRole

Delete a Role

2018.5

deleteTenants

Delete Tenants

2018.5

deleteUser

Delete a User

2018.5

getAllNonPrivateRoles

Get All Public Roles

2018.5

getAllNonPrivateRolesByTenant

Get All Public Roles for a Tenant

2018.5.2

getAllNonPrivateRolesIDByTenant

Get All Public Roles for a Tenant

2018.5.2

getAllProfiles

Get a list of al user profiles in the System

2020.0

getAllProfilesByTenantId

Get a list of all user profiles in the system for a specific tenant

2020.0

getAllRoles

Get All Roles

2018.5

getAllRolesByProfileId

Returns a list of roles assigned to the specified user profile

2020.0

getAllRolesByUser

Get all Roles for a User

2018.5

getAllTenants

Get all Tenants

2018.5

getAllUsersByCurrentTenant

Get the Current Tenant's Users

2018.5

getAllUsersByTenant

Get a Tenant's Users

2018.5

getAllUsersDataByTenantAndLicenceType

Get a Tenant's Users with specific license type

2018.5.2

getAvailableTenantLicenseCount

Get Available License Count for a Tenant

2018.5

getDefaultTenant

Get the default tenant ID

2018.5

getGroupsByRole

Get Active Directory Groups for a Role

2018.5

getLicenseCount

Get Tenant License Count

2018.5

getLicenseCount2

Get Tenant License Count

2020.26

getLicenseExpirationDate

Get License Expiration Date

2018.5

getLicenseValidationStatus

Get License Status

2018.5

getMe

Gets details for the current user.

2020.0

getPrivateProfileIdForUser

Returns the profile assigned to the specified user

2020.0

getRoleById

Get a Security Role by ID

2018.5

getRolesByName

Find Security Roles

2018.5

getTenantByName

Get Tenant by Name

2018.5

getUser

Get a User via ID

2018.5

getUserByOpenIdPrincipalName

Get a User by UPN (OpenID)

2020.20

getUserBySamlPrincipalName

Get a User by UPN (SAML)

2018.5

getUserLastLogin

Get User Last Login Timestamp

2018.5

getUserStatusById

Get User's System Status by User ID

2018.5

getUserStatusByName

Get User's System Status by Name

2018.5

getUsersByName

Get a User by UserName

2018.5

getUsersByRole

Get all Users in a Role

2018.5

searchAdGroups

Search AD Groups

2018.5

searchAdGroupsForUser

Search User’s AD Groups

2018.5

searchAdUsers

Search for Active Directory users

2018.5

searchAdUsersForGroups

Search Active Directory Group Members

2018.5

setUserAdministrationLevel

Set User's Administration Level

2018.5

toggleEnableUser

Change User's Status

2018.5

updateRolesByProfileId

Update Role Profiles

2020.0

updateTenantSeats

Updates a tenant seats

2020.0

updateUserAd

Update user settings (ACTIVE DIRECTORY)

2020.10

updateUserDb

Update user settings (Internal / DATABASE)

2020.10

updateUserOpenId

Update user settings (OpenID)

2020.20

updateUserRoles

Update a User’s Roles

2018.5

updateUserSaml

Update user settings (SAML)

2020.0

updateUsersAd

Update user settings (ACTIVE DIRECTORY)

2020.10

updateUsersDb

Update user settings (Internal / DATABASE)

2020.10

updateUsersOpenId

Update settings for multiple users (OpenID)

2020.20

updateUsersPhones

Update phones of users

2020.0

updateUsersSaml

Update settings for multiple users (SAML)

2018.5